口座振替サービス(セレクト) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

EntryTranBankaccount 取引登録

取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額+税送料が決済金額となります。

URL
/payment/EntryTranBankaccount.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=100
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranBankaccount 請求依頼

口座振替に必要な情報を指定して請求を依頼します。
・振替対象の会員には、あらかじめ口座情報が登録する必要があります。
・指定した振替指定日の請求依頼受付終了日まで本操作を行う必要があります。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数64桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

TargetDate 必須 半角数字8桁 固定
振替指定日

YYYYMMDD形式
指定可能な日は5、6、23、27日です。

Remarks 半角英数カナ記号15桁
請求内容

指定可能な文字は半角英数(大文字のみ) 半角カタカナ(大文字のみ) (). -(半角ハイフン)です。
未指定の場合は、加盟店様のショップ名カナを印字します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

CheckMode
口座有効性チェックモード

NOCHECK_ACCOUNT:口座の有効性チェックを行いません。
口座は申込確定から30日経過後に利用可能となります。利用可能となる前の口座の場合は請求依頼時にエラーとなりますが、本パラメータを指定すると、利用可能ではない場合でも請求依頼を受け付けます。
(請求依頼は受け付けますが、金融機関側で「依頼書未着」エラーとなる可能性がございます)

URL
/payment/ExecTranBankaccount.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SiteID=tsite99887902&SitePass=PASSWORD&MemberID=memberid001&TargetDate=20230105&Remarks=セイキユウナイヨウ&CheckMode=NOCHECK_ACCOUNT
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

TargetDate 半角数字8桁 固定
振替指定日

RequestAcceptEndDate 半角数字8桁 固定
振替受付終了日

本取引の請求依頼取消、請求依頼変更が可能な期日です。
本日付以降に請求依頼取消、請求依頼変更を行うことはできません

TransferReturnDate 半角数字8桁 固定
振替結果反映予定日

振替結果が取引に反映される予定日です。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=5e0e54b892e14ed03e8cf807a6053813&TargetDate=20230105&RequestAcceptEndDate=20221221&TransferReturnDate=20230111
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

BankaccountCancel 請求依頼取消

請求依頼した取引の取引ID・取引パスワードを指定すると、以前に請求依頼した取引を取消することが可能です。
該当取引の請求依頼受付終了日を過ぎると取消できなくなりますのでご注意ください。
※一度 取消処理が成功した上でもう一度取消を実施した場合はエラーになります。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/BankaccountCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

処理成功時は以下のステータスが返却されます。
・CANCEL:取消

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

BankaccountChange 請求情報変更

請求依頼した取引の取引ID・取引パスワードを指定すると、以前に請求依頼した取引の請求依頼内容を変更することが可能です。(複数回、実行可能です)
該当取引の請求依頼受付終了日を過ぎると変更できなくなりますのでご注意ください。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 半角数字8桁
変更後利用金額

指定の金額で利用金額を設定しなおします。

Tax 半角英数数字7桁
変更後税送料

指定の金額で税送料を設定しなおします。

Remarks 半角英数カナ記号15桁
変更後請求内容

指定の内容で請求内容を設定しなおします。

URL
/payment/BankaccountChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Remarks=ヘンコウゴ&Amount=90&Tax=0
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を返却します。

Status
現状態

Amount 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

Remarks 半角英数カナ記号15桁
請求内容

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=REQSUCCESS&Amount=90&Tax=0&Remarks=ヘンコウゴ
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

オーダーIDを指定すると、該当の決済結果を取得すること(以下、取引状態参照)が可能です。
通信障害でタイムアウトが発生した場合等で決済結果が取得できなかった場合は、本インターフェースにて取得してください。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

28:口座振替(セレクト)

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=28
レスポンス
正常
Status
現状態

UNPROCESSED:未決済
REQSUCCESS:請求登録
SEND:請求処理中
PAYSUCCESS:請求成功
CANCEL:請求取消
PAYFAIL:請求失敗

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss形式

JobCd
処理区分

ENTRY:取引登録
EXEC:請求依頼
RECEIVE:請求結果受信
CHANGE:請求変更
CANCEL:請求取消

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

OrderID 半角英数記号27桁
オーダーID

Amount 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

SiteID 半角英数13桁
サイトID

MemberID 半角英数記号60桁
会員ID

BaTargetDate 半角数字8桁 固定
振替指定日

YYYYMMDD形式

BaRequestAcceptEndDate 半角数字8桁 固定
請求依頼受付終了日

YYYYMMDD形式

BaTransferReturnDate 半角数字8桁 固定
振替結果反映予定日

YYYYMMDD形式

BaWithdrawalDate 半角数字8桁 固定
実引落日

YYYYMMDD形式

BaResultCode 半角英数1桁 固定
振替結果コード

振替結果を示す以下のコード
1 :資金不足
2 :預金取引なし
3 :預金者都合による振替停止
4 :預金口座振替依頼書未着もしくは不備
8 :委託者の都合による振替停止
9 :その他
E :請求不能
N :振替結果未着

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

28:口座振替(セレクト)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
Status=PAYSUCCESS&ProcessDate=20220805120000&JobCd=RECEIVE&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100&Tax=0&SiteID=tsite99887902&MemberID=memberid001&BaTargetDate=20220805&BaRequestAcceptEndDate=20220805&BaTransferReturnDate=20220805&BaWithdrawalDate=20220805&BaResultCode=1&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=28
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001